Skip to main content

ServiceAPI Properties

An object defining properties for the ServiceAPI class.

DelegationAPI​

The Delegation API is a powerful tool designed for managing user delegations within an organization. This API allows for the creation, retrieval, and management of delegation entities, which can define permissions and access rights across different users and resources. By utilizing this API, organizations can streamline the process of granting temporary access, ensuring efficient collaboration and resource management.

Type: DelegationAPI

AuthenticationAPI​

The AuthenticationAPI class provides methods for handling various authentication mechanisms within the service API. It includes login functionalities for basic authentication, token authentication, and access token-based authentication.

Type: AuthenticationAPI

DocumentManagementAPI​

The DocumentManagementAPI class provides a comprehensive set of methods for managing documents within the system. This includes functionalities for creating, retrieving, updating, and deleting documents, as well as managing their associated metadata and permissions. The API also supports operations for handling document versions, shortcuts, and folder structures, enabling users to efficiently organize and manipulate their document assets.

Type: DocumentManagementAPI

SharedAPI​

The Shared API allows you to create and manage shareable links with specific functionalities, such as starting workflows, filling out forms, and accessing files within a document management system. This API facilitates controlled access to resources by configuring various parameters such as link type, expiration, user permissions, and view settings.

Type: SharedAPI

FormManagerAPI​

The FormManagerAPI is a powerful API that allows users to create, manage, and process dynamic forms. This API facilitates operations such as form design, management of form instances, data updates, and retrieval of form control values.

Type: FormManagerAPI

OfficeWebAppsAPI​

The OfficeWebAppsAPI class provides methods to interact with Office Web Apps, including functionality to retrieve action URLs for specific documents or actions.

Type: OfficeWebAppsAPI

StudioAPI​

The StudioAPI class provides methods to interact with various Studio-related resources. This API handles sending requests to retrieve information such as deployments, versions, projects, flows, and processes.

Type: StudioAPI

BuildManagerAPI​

The BuildManagerAPI class provides functionalities for managing build operations.

Type: BuildManagerAPI

ConfigurationAPI​

The ConfigurationAPI class provides access to configuration management functionalities, allowing for the retrieval of configuration data based on specified parameters.

Type: ConfigurationAPI

HumanResourcesAPI​

The HumanResourcesAPI class provides methods for accessing user information within the service API. It includes functionalities for retrieving details of the current user, fetching users by ID, and obtaining user information by username, with built-in telemetry and exception handling.

Type: HumanResourcesAPI

The Menu Manager API provides a robust and scalable solution for managing user-specific menu structures, profiles, and menu item parameters. It allows for the dynamic generation of menus based on user roles and profiles, while also supporting detailed reporting and telemetry integration for enhanced performance monitoring. This API is designed to offer flexibility and ease of integration with enterprise applications.

Type: MenuManagerAPI

DataSourceManagerAPI​

The DataSourceManager API provides functionality for managing external data sources such as databases, REST services, and other third-party providers. It enables seamless access and querying of data across multiple environments, abstracting complex connection management and query execution logic. This API is particularly useful in scenarios where dynamic and diverse data access is required within applications.

Type: DataSourceManagerAPI

WorkflowManagerAPI​

The WorkflowManagerAPI class provides methods for managing workflows within the system, including creating, starting, and continuing workflows, as well as retrieving user approvals and process requests.

Type: WorkflowManagerAPI